<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>parse (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.JSON">
<link rel="up" href="../boost__json__parse.html" title="parse">
<link rel="prev" href="../boost__json__parse.html" title="parse">
<link rel="next" href="overload2.html" title="parse (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost__json__parse.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__json__parse.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="json.ref.boost__json__parse.overload1"></a><a class="link" href="overload1.html" title="parse (1 of 2 overloads)">parse (1 of
        2 overloads)</a>
</h5></div></div></div>
<p>
          Return parsed JSON as a <a class="link" href="../boost__json__value.html" title="value"><code class="computeroutput"><span class="identifier">value</span></code></a>.
        </p>
<h6>
<a name="json.ref.boost__json__parse.overload1.h0"></a>
          <span class="phrase"><a name="json.ref.boost__json__parse.overload1.synopsis"></a></span><a class="link" href="overload1.html#json.ref.boost__json__parse.overload1.synopsis">Synopsis</a>
        </h6>
<p>
          Defined in header <code class="literal">&lt;<a href="https://github.com/cppalliance/json/blob/master/include/boost/json/parse.hpp" target="_top">boost/json/parse.hpp</a>&gt;</code>
        </p>
<pre class="programlisting"><span class="identifier">value</span>
<span class="identifier">parse</span><span class="special">(</span>
    <span class="identifier">string_view</span> <span class="identifier">s</span><span class="special">,</span>
    <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
    <span class="identifier">storage_ptr</span> <span class="identifier">sp</span> <span class="special">=</span> <span class="special">{},</span>
    <span class="identifier">parse_options</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">opt</span> <span class="special">=</span> <span class="special">{});</span>
</pre>
<h6>
<a name="json.ref.boost__json__parse.overload1.h1"></a>
          <span class="phrase"><a name="json.ref.boost__json__parse.overload1.description"></a></span><a class="link" href="overload1.html#json.ref.boost__json__parse.overload1.description">Description</a>
        </h6>
<p>
          This function parses an entire string in one step to produce a complete
          JSON object, returned as a <a class="link" href="../boost__json__value.html" title="value"><code class="computeroutput"><span class="identifier">value</span></code></a>. If the buffer does not
          contain a complete serialized JSON, an error occurs. In this case the returned
          value will be null, using the default memory resource.
        </p>
<h6>
<a name="json.ref.boost__json__parse.overload1.h2"></a>
          <span class="phrase"><a name="json.ref.boost__json__parse.overload1.complexity"></a></span><a class="link" href="overload1.html#json.ref.boost__json__parse.overload1.complexity">Complexity</a>
        </h6>
<p>
          Linear in <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">size</span><span class="special">()</span></code>.
        </p>
<h6>
<a name="json.ref.boost__json__parse.overload1.h3"></a>
          <span class="phrase"><a name="json.ref.boost__json__parse.overload1.exception_safety"></a></span><a class="link" href="overload1.html#json.ref.boost__json__parse.overload1.exception_safety">Exception
          Safety</a>
        </h6>
<p>
          Strong guarantee. Calls to <code class="computeroutput"><span class="identifier">memory_resource</span><span class="special">::</span><span class="identifier">allocate</span></code>
          may throw.
        </p>
<h6>
<a name="json.ref.boost__json__parse.overload1.h4"></a>
          <span class="phrase"><a name="json.ref.boost__json__parse.overload1.return_value"></a></span><a class="link" href="overload1.html#json.ref.boost__json__parse.overload1.return_value">Return Value</a>
        </h6>
<p>
          A value representing the parsed JSON, or a null if any error occurred.
        </p>
<h6>
<a name="json.ref.boost__json__parse.overload1.h5"></a>
          <span class="phrase"><a name="json.ref.boost__json__parse.overload1.parameters"></a></span><a class="link" href="overload1.html#json.ref.boost__json__parse.overload1.parameters">Parameters</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">s</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The string to parse.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">ec</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Set to the error, if any occurred.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">sp</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The memory resource that the new value and all of its elements
                    will use. If this parameter is omitted, the default memory resource
                    is used.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">opt</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The options for the parser. If this parameter is omitted, the
                    parser will accept only standard JSON.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="json.ref.boost__json__parse.overload1.h6"></a>
          <span class="phrase"><a name="json.ref.boost__json__parse.overload1.see_also"></a></span><a class="link" href="overload1.html#json.ref.boost__json__parse.overload1.see_also">See
          Also</a>
        </h6>
<p>
          <a class="link" href="../boost__json__parse_options.html" title="parse_options"><code class="computeroutput"><span class="identifier">parse_options</span></code></a>,
          <a class="link" href="../boost__json__stream_parser.html" title="stream_parser"><code class="computeroutput"><span class="identifier">stream_parser</span></code></a>.
        </p>
<p>
          Convenience header <code class="literal">&lt;<a href="https://github.com/cppalliance/json/blob/master/include/boost/json.hpp" target="_top">boost/json.hpp</a>&gt;</code>
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Vinnie Falco<br>Copyright © 2020 Krystian Stasiowski<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../boost__json__parse.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__json__parse.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
